Skip to main content

Hierarchy Notes

Hierarchy Notes​

A Hierarchy Note is a separate note with an outline. This serves as a way to create a Breadcrumbs structure without having to add metadata to every note. Simply create a table-of-contents-like outline, and Breadcrumbs will treat it as a parent-child structure.

To use this new feature, go to the "Hierarchy Notes" settings tab to tell Breadcrumbs:

  1. Which notes to look at, and
  2. Which type of relation to treat the items as.

From this point onwards the example will be used for up relation, but you can also use another kinds of relation

Example​

This example will add the listed items to the Breadcrumbs hierarchy.

1 is the parent of 1.1 and 1.2.

1.1 has no children.

1.2 is the parent of 1.2.1, 1.2.2, and 1.2.3.

and so on...

- [[1]]
- [[1.1]]
- [[1.2]]
- [[1.2.1]]
- [[1.2.2]]
- [[1.2.2.1]]
- [[1.2.3]]
- [[1.3]]
- [[2]]
- [[2.1]]
- [[2.1.1]]
- [[2.1.1.1]]

Other content in the hierarchy note​

Breadcrumbs only considers list items, so you can have any other content in the note, as long as Obsidian can tell what the parent of each item is.

So this is allowed:

---
parent: [[A]]
---

- [[1]]

- [[1.1]]

- [[1.2]]

- [[1.2.1]]

- [[1.3]]

Specifying Different Up Fields​

You can tell Breadcrumbs to override the default up field name, by putting the field name you want before the note:

- [[1]]
- parent [[1.1]]
- up [[1.2]]
- top [[1.3]]

Will mean:

  • 1.1 -parent-> 1
  • 1.2 -up-> 1
  • 1.3 -top-> 1

Hierarchy Note Adjustor​

Run the command Adjust Hierarchy Notes to open this feature.

If you have more than one HN, you will first need to choose which one to adjust

After choosing one, you will see a new modal showing each line of the chosen HN

There are a few different functions you can use here:

  1. Enter to jump to that line in the chosen HN.
  2. Delete to delete that line in the chosen HN.
  3. Shift + ↑/→/↓ to open the HN Adjuster

If you ran any of the commands in 3, you'll see a new modal where you can add a parent/sibling/child to the chosen line in the chosen HN

Even if you chose ↑ at first, you can still change it to ↓ or →. Press Submit to add the new item to the chosen HN.